Investigator API
GET Pgpis
Overview
Retrieves the list of PGPIs.
OperationId: GET Pgpis
Authorization Method(s): OAuth
Verb: GET
End Point: /api/configuration/SearchConfiguration/pgpis
Query parameters in an API operation are key-value pairs that are included in the URL of an API request to filter or modify the data returned by the API. They come after the `?` in the URL and are often used to pass optional parameters like search terms, pagination information, sorting criteria, or filters to narrow down the data in the response.
| Display String | Field Name | Field Type |
|---|---|---|
| Client Number* | ClientNumber | string |
| Api-version* | api-version | undefined |
Overview
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 200 | PGPI search results were successfully returned. |
| 400 | The request could not be processed due to an error |
| 401 | Use doesn't have access to use this API. |
| 404 | Not found records produce an empty response. |